Skip to main content
Feedback

Query Outbound Activity

The Query Outbound Activity operation lets you programmatically retrieve data about pending and delivered record update requests to outbound sources. The data aligns with information you can access in the user interface on the Reporting > Outbound Activity screen.

A delivery is recorded only upon acknowledgment by an integration process on behalf of the targeted source. Read Fetch Channel Updates for more information on automatic and Acknowledge Previously Fetched Channel Updates for more information manual acknowledgement.

Basic authentication

  • To perform this operation using Basic auth, send an HTTP POST request to:

    https://<base URL>/mdm/universes/<universeID>/sources/<sourceID>/channels/query

JWT authentication

  • To perform this operation using JSON Web Token (JWT) auth, send an HTTP POST request to: https://<base URL>/mdm/universes/<universeID>/sources/<sourceID>/channels/query?repositoryId=<repository ID>

You must have the following MDM privileges:

  • MDM - Activity Reporting

Path parameters

universeID
ID of the universe (deployed model). String. Required.

sourceID
ID of the outbound source. String. Required.

Query parameters

repositoryId
ID of the repository. Case sensitive. Required with JWT authentication only. You can obtain the repository ID from the URL after navigating to the repository in the user interface.

Request parameters

queryType
Status of the update requests you want to query. String. Required. Values are:

  • PENDING - Displays pending update requests for the specified universe and target source.
  • HISTORY - Displays delivered and acknowledged update requests for the specified universe and target source.

offsetToken
Add the offset token value from the previous page of results to retrieve the next page of results. String. Optional.

limit
Indicates the maximum number of results to include in a page. Boomi DataHub enforces a maximum of 200 requests per page regardless of the limit value. Integer. Optional.

sortBy
Indicates that you want to sort by a filter parameter. For example, createdDate. String. Optional.

sortAsc
Sorts results in ascending or descending order. Boolean. Optional.

  • true - sorts results in ascending order.
  • false - sorts results in descending order.

Query filter parameters

Wrap the following query filter parameters in the <filter> tag.

  • deliveryId - filters record updates based on the Delivery ID assigned when the batch of update requests is delivered. This filter only applies when the queryType is set to HISTORY. String. Optional.

  • grid - filter by golden record ID. String. Optional.

  • createdDate - filter by date and time at which the update request was created in the batch. Datetime. Optional. This tag wraps the to and from tag.

    • from: The start datetime for filtering requests. Format is yyyy-MM-dd'T'HH:mm:ss'Z'. Value can be an empty string.
    • to: The end datetime for filtering requests. Format is yyyy-MM-dd'T'HH:mm:ss'Z'. Value can be an empty string.
      If createdRelativeTime filter is specified, it overrides this filter.

  • createdRelativeTime - filters by a time frame relative to the current date and time. String. Optional. Values are:

    • PAST_HOUR
    • PAST_24_HOURS
    • PAST_WEEK

  • deliveryType - filters by deliverable and undeliverable update requests only when queryType is PENDING. String. Optional.

    • UNDELIVERABLE - Held update requests are undeliverable. An update request is held if it is for a golden record that references a golden record that is not linked to a record in the source and then only if the underlying domain model enforces referential integrity for update requests.
    • DELIVERABLE - Pending updates requests that are not held.

  • opType - filters by operation type. String. Optional. Values are:

    • CREATE - filter by update requests for record creation.
    • UPDATE - filter by update requests for record changes.
    • DELETE - filter by update requests for record deletion.
    • RESTORE - filter by update requests for record restoration from end-dated to active status.
    • REJECT_DUPLICATE - filter by update quests to reject the update as a duplicate of existing source entities.

Request body examples

<OutboundActivityRequest sortBy="createdDate" sortAsc="false">
   <queryType>PENDING</queryType>
   <filter>
       <opType>CREATE</opType>
   </filter>
</OutboundActivityRequest>
<OutboundActivityRequest sortBy="createdDate" sortAsc="false" limit="3">
   <queryType>PENDING</queryType>
   <filter>
       <deliveryType>DELIVERABLE</deliveryType>
   </filter>
</OutboundActivityRequest>

Responses

  • 200 (OK) The body contains the XML representation of the query results. It returns a maximum of 200 results per request unless the limit parameter for a given request specifies a lower maximum number of results.

Sample response body:

<OutboundActivityResponse resultCount="4" totalCount="4">
   <OutboundActivity>
       <id>4</id>
       <grid>539e13f5-4cab-4d83-8457-6f79c49a3828</grid>
       <opType>CREATE</opType>
       <createdAt>2025-02-21T00:19:43Z</createdAt>
       <title>Lola Rubin</title>
   </OutboundActivity>
   <OutboundActivity>
       <id>3</id>
       <grid>5cc30f9a-dfc7-4326-a299-61ac8c953177</grid>
       <opType>CREATE</opType>
       <createdAt>2025-02-21T00:19:43Z</createdAt>
       <title>Robert Reeves</title>
   </OutboundActivity>
   <OutboundActivity>
       <id>2</id>
       <grid>8091c411-24d2-4302-9ad6-42cb655f26ac</grid>
       <opType>CREATE</opType>
       <createdAt>2025-02-21T00:19:43Z</createdAt>
       <title>Rick Norwood</title>
   </OutboundActivity>
   <OutboundActivity>
       <id>1</id>
       <grid>4cd20c26-d2cd-40e8-9cf5-ce28ee41ae0b</grid>
       <opType>CREATE</opType>
       <createdAt>2025-02-21T00:19:42Z</createdAt>
       <title>Scott Chapman</title>
   </OutboundActivity>
</OutboundActivityResponse>
  • 400 (Bad Request) The universeID parameter value contains only space characters. Sample response body:
  <error>
    <message>The given universe id is blank.</message>
  </error>
  • 400 (Bad Request) sourceID does not identify a source that exists in the specified account. Sample response body:
<error>
<message>A source with ID 'WD' does not exist in this account.</message>
</error>
  • 400 (Bad Request) Request body does not contain the required queryType parameter. Sample response body:
<error>
   <message>queryType cannot be null or empty.</message>
</error>
  • 400 (Bad Request) - The Delivery ID filter is not available if the queryType is set to PENDING. Sample response body:
<error>
   <message>Invalid param "deliveryId" for OutboundActivityRequest with queryType "PENDING"</message>
</error>
  • 400 (Bad Request) - The Delivery Type filter is not available when the queryType is set to HISTORY. Sample response body:
<error>
   <message>Invalid param "deliveryType" for OutboundActivityRequest with queryType "HISTORY"</message>
</error>
  • 404 (Not Found) universeID does not identify a universe under the authenticated account. Sample response body:
  <error>
    <message>A universe with id 'ac11cc59-c77a-4afe-8c92-ed86a7daabec' does not exist.</message>
    <message>Universe definition with id 'ac11cc59-c77a-4afe-8c92-ed86a7daabec' could not be loaded from plugin component directory 'plugins/mdm/bundles/ac11cc59-c77a-4afe-8c92-ed86a7daabec'.</message>
  </error>
  • 401 (Invalid Credentials) JWT auth token is expired. Sample response body:
<error>
<message>Problem accessing /mdm/universes. Reason: Invalid credentials</message>
</error>
  • 403 (You do not have permissions to access this resource) User does not have the required MDM privilege to perform the action. Applicable to JWT auth only. Sample response body:
<error>
<message>You do not have permissions to access this resource.</message>
</error>
On this Page